/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wse;

import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.ProcessingException;
import cgl.narada.wsinfra.exception.WsFaultException;
import cgl.narada.wsinfra.schemas.eventing.SubscribeDocument;
import cgl.narada.wsinfra.schemas.eventing.SubscribeResponseDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.wsa.AddressingHeaders;

/** This interface encapsulates the behavior of a WS-Eventing source node.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.7 $
*/

public interface WseSource {

  /** The method to process a SubscriptionRequest issued by a Sink. If this
      request is successfully processed a SubscribeResponseDocument is issued.
      If the request is NOT successful a WsFaultException is thrown. */ 
  public SubscribeResponseDocument
  processSubscribeRequest(SubscribeDocument subscribeDocument)
    throws WsFaultException, ProcessingException;



  /** This method is used to update the subscription tables maintained at
      the source. ONLY requests successfully renewed by the
      SubscriptionManager are forwarded onto the source for updates at the
      source. This method will throw an error if the request was issued by
      anyone BUT the registered SubscriptionManager.

      wse:Identifier of the subscription.
      wse:From should match Subscription Manager for the subscription.
      wse:RenewResponse which would indicate the new expiry time for the
      subscription.
  */
  public void processSubscriptionRenewal(EnvelopeDocument envelopeDocument,
					 AddressingHeaders addressingHeaders)
    throws WsFaultException;


  /** This method is used to update the subscription tables maintained at
      the source. Unsubscribe requests processed by the SubscriptionManager
      are forwarded onto the source for updates at the source. This method will
      throw an error if the request was issued by anyone BUT the registered
      SubscriptionManager for the subscription in question.

      wse:Identifier of the subscription
      wse:From shoould match SubscriptionManager for the subscription. */
  public void processUnsubscribe(EnvelopeDocument envelopeDocument,
				 AddressingHeaders addressingHeaders)
    throws WsFaultException;


  /** This method is used to ensure the dissemination of a notification
      to registered subscriptions. */
  public void processNotification(EnvelopeDocument envelopeDocument,
				  AddressingHeaders addressingHeaders)
    throws ProcessingException, MessageFlowException;

}
